Deal Usage API
Request Attributes
Y – Required (Must be set in the input)
O – Optional (May be sent in addition to required fields).
/deals
Method: GET
Query Parameters
dealId
offset
max
| Object | Attribute | Type | Required | Possible Values | Description |
|---|---|---|---|---|---|
| dealid | Number | Y | Required DealId | ||
| offset | Number | Y | This attribute enables the pagination. Helps to fetch the records starting with specific Index value | ||
| max | Number | Y | Controls the number of records to be retrieved per page. Max allowed value is 500 per request |
/deals/{dealid}/details
Request Parameters
Method: GET
Body :
| Object | Attribute | Type | Required | Possible Values | Description |
|---|---|---|---|---|---|
| dealid | Number | Y | Required DealId | ||
| offset | Number | Y | This attribute enables the pagination. Helps to fetch the records starting with specific Index value | ||
| max | Number | Y | Controls the number of records to be retrieved per page. Max allowed value is 500 per request |
/deals/{dealid}/transaction-lines
Request Parameters
Method: GET
| Object | Attribute | Type | Required | Possible Values | Description | |
|---|---|---|---|---|---|---|
| dealid | Number | Y | Required DealId | |||
| offset | Number | Y | This attribute enables the pagination. Helps to fetch the records starting with specific Index value | |||
| max | Number | Y | Controls the number of records to be retrieved per page. Max allowed value is 500 per request | |||
| lineType | String | Y | Eg: dsv, pos, cisco-order, claim | Supports only one value in a request call |